Skip to content

Add sphing toolchain#467

Draft
ramceb wants to merge 1 commit intomainfrom
mb_sphinx_toolchain
Draft

Add sphing toolchain#467
ramceb wants to merge 1 commit intomainfrom
mb_sphinx_toolchain

Conversation

@ramceb
Copy link
Copy Markdown
Contributor

@ramceb ramceb commented Apr 2, 2026

📌 Description

This PR adds a bazel toolchain for sphinx builds,
which allows to inject the binary which is used
for build html documentation

🚨 Impact Analysis

  • This change does not violate any tool requirements and is covered by existing tool requirements
  • This change does not violate any design decisions
  • Otherwise I have created a ticket for new tool qualification

✅ Checklist

  • Added/updated documentation for new or changed features
  • Added/updated tests to cover the changes
  • Followed project coding standards and guidelines

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 2, 2026 •
edited
Loading

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //src:license-check

Status: ⚠️ Needs Review

Click to expand output 
[License Check Output]
2026/04/08 11:22:11 Downloading https://releases.bazel.build/8.4.2/release/bazel-8.4.2-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server (8.4.2) and connecting to it...
INFO: Invocation ID: fcf119a6-3746-463f-8ac1-9563dc47ea7e
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
Loading: 0 packages loaded
    currently loading: src
Loading: 0 packages loaded
    currently loading: src
Loading: 0 packages loaded
    currently loading: src
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //src:license-check (54 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (76 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (80 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (83 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (132 packages loaded, 2549 targets configured)

Analyzing: target //src:license-check (141 packages loaded, 3998 targets configured)

Analyzing: target //src:license-check (152 packages loaded, 7618 targets configured)

Analyzing: target //src:license-check (152 packages loaded, 7624 targets configured)

Analyzing: target //src:license-check (152 packages loaded, 7624 targets configured)

Analyzing: target //src:license-check (152 packages loaded, 7624 targets configured)

Analyzing: target //src:license-check (156 packages loaded, 9636 targets configured)

INFO: Analyzed target //src:license-check (157 packages loaded, 9762 targets configured).
[8 / 16] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //src:license.check.license_check up-to-date:
  bazel-bin/src/license.check.license_check
  bazel-bin/src/license.check.license_check.jar
INFO: Elapsed time: 27.569s, Critical Path: 2.41s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/src/license.check.license_check src/formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 2, 2026

The created documentation from the pull request is available at: docu-html

@ramceb ramceb force-pushed the mb_sphinx_toolchain branch from c38f06f to cae7394 Compare April 8, 2026 10:53
@ramceb ramceb force-pushed the mb_sphinx_toolchain branch from cae7394 to d13ab88 Compare April 8, 2026 11:22
@AlexanderLanin
Copy link
Copy Markdown
Member

AlexanderLanin commented Apr 9, 2026

Having something overwritable/injectable seems ok. However this adds yet another dependency. I would rather remove the existing dependencies. But of course I dont know how to do that 😆

@ramceb
Copy link
Copy Markdown
Contributor Author

ramceb commented Apr 10, 2026

Having something overwritable/injectable seems ok. However this adds yet another dependency. I would rather remove the existing dependencies. But of course I dont know how to do that 😆
The problem was the circular dependency between tooling and docs-as-code. We removed the dependency from tooling to docs-as-code in eclipse-score/tooling#116.
The already existing dependency from docs-as-code to tooling we need to keep. So the dependency chain looks as follows

module which wants to generate documentation
            ↓
       docs-as-code
            ↓
          tooling

docs-as-code defines the score_toolchain incl. all of the metamodel for generating the documentation

a-zw
a-zw reviewed Apr 10, 2026
View reviewed changes
Comment thread bazel/toolchains/BUILD
)

toolchain(
name = "score_toolchain",
Copy link
Copy Markdown
Contributor

@a-zw a-zw Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This toolchain/file is not used so far? Why do we need it?

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

Thanks for the pull request. This thread has been quiet for 30 days, so we are marking it as stale for now. Please take a quick look and let us know whether it is still up to date, still relevant, needs review, or is ready to merge. Any new activity will remove the stale label automatically. If nothing changes in the next 10 days, we will close it to keep the backlog current.

@github-actions github-actions Bot added the stale label May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexanderLanin AlexanderLanin Awaiting requested review from AlexanderLanin AlexanderLanin will be requested when the pull request is marked ready for review AlexanderLanin is a code owner

@MaximilianSoerenPollak MaximilianSoerenPollak Awaiting requested review from MaximilianSoerenPollak MaximilianSoerenPollak will be requested when the pull request is marked ready for review MaximilianSoerenPollak is a code owner

@dcalavrezo-qorix dcalavrezo-qorix Awaiting requested review from dcalavrezo-qorix dcalavrezo-qorix will be requested when the pull request is marked ready for review dcalavrezo-qorix is a code owner

@nradakovic nradakovic Awaiting requested review from nradakovic nradakovic will be requested when the pull request is marked ready for review nradakovic is a code owner

1 more reviewer

@a-zw a-zw a-zw left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

stale

Projects

INF - Infrastructure Community
Status: Backlog

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ramceb @AlexanderLanin @a-zw